docs: add example config.toml #5175
Conversation
…one was slower. I had GPT-5 scan the codebase for every accepted config key, check the defaults, and generate a single example config.toml with annotations. It lists all keys Codex reads from TOML, sets each to its effective default where it exists, leaves optional ones commented, and adds short comments on purpose and valid values. This should make onboarding faster and reduce configuration errors. I can rename it to config.example.toml or move it under docs/ if you prefer.
docs/config.toml
Outdated
| @@ -0,0 +1,301 @@ | |||
| # Codex configuration template (config.toml) | |||
There was a problem hiding this comment.
Let's rename this file to docs/example-config.md so it can be displayed as a docs file.
docs/config.toml
Outdated
| @@ -0,0 +1,301 @@ | |||
| # Codex configuration template (config.toml) | |||
There was a problem hiding this comment.
Rather than referring to this as a "configuration template", let's call it an "example configuration" or something like that. I'm concerned that some users will find the term "template" to be confusing.
docs/config.toml
Outdated
| # | ||
| # This file lists all keys Codex reads from config.toml, their default values, | ||
| # and concise explanations. Values here mirror the effective defaults compiled | ||
| # into the CLI as of this repository. Adjust as needed. |
There was a problem hiding this comment.
"as of this repository" is a bit cumbersome. Maybe just delete this phrase.
|
Thanks for the contribution, and apologies that it has taken so long to respond. Our PR backlog got quite long, and we're catching up. I think this would be a good addition to the codex docs. |
Sure! No problem! I just made the adjustments and also updated the file to match the keys that changed in the most recent releases. Thanks for the reply! |
|
Thanks again for the contribution! |
2 participants
I was missing an example config.toml, and following docs/config.md alone was slower. I had GPT-5 scan the codebase for every accepted config key, check the defaults, and generate a single example config.toml with annotations. It lists all keys Codex reads from TOML, sets each to its effective default where it exists, leaves optional ones commented, and adds short comments on purpose and valid values. This should make onboarding faster and reduce configuration errors. I can rename it to config.example.toml or move it under docs/ if you prefer.